home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 May / EnigmA AMIGA RUN 18 (1997)(G.R. Edizioni)(IT)[!][issue 1997-05][EAR-CD II].iso / earcd / dev / misc / bump24.lha / Bump.doc < prev    next >
Text File  |  1997-02-26  |  6KB  |  141 lines
  1.  
  2.                                Bump v2.3
  3.  
  4.               --> A tool to keep your sources up-to-date <--
  5.  
  6.                            KICKSTART 2.0 ONLY
  7.  
  8.                                    by
  9.  
  10.                             Jan van den Baard
  11.  
  12.                                changes by
  13.  
  14.                              Clark Williams
  15.  
  16.                              This program is
  17.                                 FREEWARE
  18.  
  19.             and remains (c) Copyright 1992 Jaba Development
  20.  
  21.                                 Changes are
  22.           (c) COPYRIGHT 1997 Software Industry & General Hardware
  23.  
  24.   The authors cannot be held liable for the suitability or accuracy  of this
  25. program.   Any damage directly or indirectly caused by the use or  misuse  of
  26. of this program is the sole responsibility of the user her/him self.
  27.  
  28.   Bump is a little utility to make it easy to keep the version string in your
  29. sources up-to-date. It's ment to be called from the cli or a makefile. Here's
  30. how to call it:
  31.  
  32.   Format:     Bump <Name> [INCVER] [INCREV] [SETVER = num] [SETREV = num]
  33.                    [QUIET] [ONLYDATE]
  34.  
  35.   Template:   Name/A,INCVER/S,INCREV/S,SETVER/K/N,SETREV/K/N,QUIET/S,
  36.               ONLYDATE/S,USADATE/S
  37.  
  38.   With:
  39.               Name     = The name  of  the  source  code  which  contains the
  40.                          version string that must be updated.
  41.  
  42.               INCVER   = Specifying this  argument   causes  the  program  to
  43.                          increase the version number by one.
  44.  
  45.               INCREV   = Specifying this  argument   causes  the  program  to
  46.                          increase the revision number  by one.    This is the
  47.                          default setting.
  48.  
  49.               SETVER   = With this argument you can set the version number to
  50.                          what you want.
  51.  
  52.               SETREV   = With  this argument  you can set the revision number
  53.                          to what you want.
  54.  
  55.               QUIET    = Specifying this will prevent Bump from printing  the
  56.                          progress information on the console.
  57.  
  58.               ONLYDATE = This  specifies  that bump must only re-set the date
  59.                          in the version string.
  60.  
  61.               USADATE  = Specifies that the user wishes to use USA date format
  62.                          of dd.mm.yy instead of the default European date
  63.                          format of yyyy.mm.dd.
  64.  
  65.               NOCENT   = Do NOT add the century to the date format (either USA
  66.                          or European).
  67.  
  68.   Purpose:    To update the version string in a source code file.
  69.  
  70.   Specification:
  71.     BUMP reads the source code file into memory and  searches for the  string
  72.     "$VER: ". This is identifies the version string.   If  this is  found the
  73.     program  looks  through  the  version  string  to  find  the  version and
  74.     revision numbers.     Then it updates  these  numbers and writes the file
  75.     back to the disk. NOTE:  The version  string  must be formed as described
  76.     in the  "User Interface  Style  Guide"  which  is  as follows:
  77.  
  78.             $VER: <name> <version>.<revision> (<d>.<m>.<y>)
  79.  
  80.             <name>      The name of the program.
  81.             <version>   Major version number.
  82.             <revision>  Minor revision number.
  83.             <d>         Day in month created (number)
  84.             <m>         Month created (number)
  85.             <y>         Year created (number)
  86.  
  87.     The  program  counts  the  '.', '(' and ')'  characters that occur in the
  88.     version string and if it doesn't check out the program exits.    When you
  89.     have an  assembler program called "blurp" created on  friday  the seventh
  90.     of february 1992 and it's version is 37.295  the  string should  be coded
  91.     as follows:
  92.  
  93.             version_string:
  94.                     dc.b    '$VER: BLURP 37.295 (7.2.92)',0
  95.  
  96.     When the next day you add a feature you  should call  Bump the  following
  97.     way before assembling the source:
  98.  
  99.             Bump Blurp.s INCREV
  100.  
  101.     After this the version string has been changed to the following:
  102.  
  103.             version_string:
  104.                     dc.b    '$VER: BLURP 37.296 (8.2.92)',0
  105.  
  106.     The same thing can be done with C sources.
  107.  
  108.             UBYTE *version_string = "$VER: BLURP 37.295 (7.2.92)";
  109.  
  110.     After you call Bump Blurp.c INCREV the line with the version string reads
  111.  
  112.             UBYTE *version_string = "$VER: BLURP 37.296 (8.2.92)";
  113.  
  114.     As you can see BUMP automatically changes the date to the system  time so
  115.     be  sure that  your clock  is set correctly.  BUMP is pure an can be made
  116.     resident.
  117.  
  118.   Bug reports,  suggestions,  postcards,  flames,  criticism,  contributions,
  119. ideas, gifts, etc., etc., etc......... to:
  120.  
  121.                                            Jan van den Baard
  122.                                            Bakkerstraat 176
  123.                                            3082 HE, Rotterdam
  124.                                            The Netherlands
  125.  
  126.                                            FIDO: 2:500/29 (Jan van.den.Baard)
  127.  
  128.  
  129.  
  130.   The changes which have been incorporated into this version of Bump include
  131. the following:
  132.  
  133.   All dates are written with a minimum of two zeros (leading zeros are added).
  134.   The date format is now written in the standard European format of yy.mm.dd
  135.   instead of the ludicrous dd.mm.yy suggested by the style guide.  The format
  136.   of yy.mm.dd is a date which is always sorted within the century and a date
  137.   which is yyyy.mm.dd is always sorted within 10000 years.  It can be used
  138.   without worring about the encroaching melinium.  This program will output
  139.   all 4 digits in the year unless the NOCENT switch is included in the command
  140.   string.
  141.